<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2011<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>     getCoveredAnnotations() contains code adapted from the UIMA Subiterator class.<a name="line.19"></a>
<FONT color="green">020</FONT>     */<a name="line.20"></a>
<FONT color="green">021</FONT>    package org.uimafit.util;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    import static java.util.Arrays.asList;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.AbstractCollection;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.util.ArrayList;<a name="line.26"></a>
<FONT color="green">027</FONT>    import java.util.Collection;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.util.Iterator;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.util.List;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.cas.ArrayFS;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.cas.CAS;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.uima.cas.FSIterator;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.uima.cas.FeatureStructure;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.uima.cas.Type;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.uima.cas.TypeSystem;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.uima.cas.text.AnnotationFS;<a name="line.37"></a>
<FONT color="green">038</FONT>    import org.apache.uima.cas.text.AnnotationIndex;<a name="line.38"></a>
<FONT color="green">039</FONT>    import org.apache.uima.jcas.cas.FSList;<a name="line.39"></a>
<FONT color="green">040</FONT>    import org.apache.uima.jcas.cas.NonEmptyFSList;<a name="line.40"></a>
<FONT color="green">041</FONT>    import org.apache.uima.jcas.cas.TOP;<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>    /**<a name="line.43"></a>
<FONT color="green">044</FONT>     * Bridge between Java {@link Collection Collections} from different representations of collections<a name="line.44"></a>
<FONT color="green">045</FONT>     * of UIMA {@link FeatureStructure FeatureStructures}.<a name="line.45"></a>
<FONT color="green">046</FONT>     *<a name="line.46"></a>
<FONT color="green">047</FONT>     * @author Richard Eckart de Castilho<a name="line.47"></a>
<FONT color="green">048</FONT>     *<a name="line.48"></a>
<FONT color="green">049</FONT>     * @param &lt;T&gt; data type.<a name="line.49"></a>
<FONT color="green">050</FONT>     */<a name="line.50"></a>
<FONT color="green">051</FONT>    public abstract class FSCollectionFactory&lt;T extends FeatureStructure&gt; extends AbstractCollection&lt;T&gt; {<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>            @SuppressWarnings({ "unchecked", "rawtypes" })<a name="line.53"></a>
<FONT color="green">054</FONT>            public static Collection&lt;FeatureStructure&gt; create(CAS cas, Type type)<a name="line.54"></a>
<FONT color="green">055</FONT>            {<a name="line.55"></a>
<FONT color="green">056</FONT>                    // If the type is an annotation type, we can use the annotation index, which directly<a name="line.56"></a>
<FONT color="green">057</FONT>                    // provides us with its size. If not, we have to use getAllIndexedFS() which we have to<a name="line.57"></a>
<FONT color="green">058</FONT>                    // scan from beginning to end in order to determine its size.<a name="line.58"></a>
<FONT color="green">059</FONT>                    TypeSystem ts = cas.getTypeSystem();<a name="line.59"></a>
<FONT color="green">060</FONT>                    if (ts.subsumes(cas.getAnnotationType(), type)) {<a name="line.60"></a>
<FONT color="green">061</FONT>                            return (Collection) create(cas.getAnnotationIndex(type));<a name="line.61"></a>
<FONT color="green">062</FONT>                    }<a name="line.62"></a>
<FONT color="green">063</FONT>                    else {<a name="line.63"></a>
<FONT color="green">064</FONT>                            return create(cas.getIndexRepository().getAllIndexedFS(type));<a name="line.64"></a>
<FONT color="green">065</FONT>                    }<a name="line.65"></a>
<FONT color="green">066</FONT>            }<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>            public static &lt;T extends FeatureStructure&gt; Collection&lt;T&gt; create(FSIterator&lt;T&gt; aIterator)<a name="line.68"></a>
<FONT color="green">069</FONT>            {<a name="line.69"></a>
<FONT color="green">070</FONT>                    return new FSIteratorAdapter&lt;T&gt;(aIterator);<a name="line.70"></a>
<FONT color="green">071</FONT>            }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>            public static &lt;T extends AnnotationFS&gt; Collection&lt;T&gt; create(AnnotationIndex&lt;T&gt; aIndex)<a name="line.73"></a>
<FONT color="green">074</FONT>            {<a name="line.74"></a>
<FONT color="green">075</FONT>                    return new AnnotationIndexAdapter&lt;T&gt;(aIndex);<a name="line.75"></a>
<FONT color="green">076</FONT>            }<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>            public static Collection&lt;FeatureStructure&gt; create(ArrayFS aArray)<a name="line.78"></a>
<FONT color="green">079</FONT>            {<a name="line.79"></a>
<FONT color="green">080</FONT>                    return create(aArray, null);<a name="line.80"></a>
<FONT color="green">081</FONT>            }<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>            public static Collection&lt;FeatureStructure&gt; create(ArrayFS aArray, Type type)<a name="line.83"></a>
<FONT color="green">084</FONT>            {<a name="line.84"></a>
<FONT color="green">085</FONT>                    TypeSystem ts = aArray.getCAS().getTypeSystem();<a name="line.85"></a>
<FONT color="green">086</FONT>                    List&lt;FeatureStructure&gt; data = new ArrayList&lt;FeatureStructure&gt;(aArray.size());<a name="line.86"></a>
<FONT color="green">087</FONT>                    for (int i = 0; i &lt; aArray.size(); i++) {<a name="line.87"></a>
<FONT color="green">088</FONT>                            FeatureStructure value = aArray.get(i);<a name="line.88"></a>
<FONT color="green">089</FONT>                            if (value != null &amp;&amp; (type == null || ts.subsumes(type, value.getType()))) {<a name="line.89"></a>
<FONT color="green">090</FONT>                                    data.add(value);<a name="line.90"></a>
<FONT color="green">091</FONT>                            }<a name="line.91"></a>
<FONT color="green">092</FONT>                    }<a name="line.92"></a>
<FONT color="green">093</FONT>                    return asList(data.toArray(new FeatureStructure[data.size()]));<a name="line.93"></a>
<FONT color="green">094</FONT>            }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>            // Using TOP here because FSList is only available in the JCas.<a name="line.96"></a>
<FONT color="green">097</FONT>            public static Collection&lt;TOP&gt; create(FSList aList)<a name="line.97"></a>
<FONT color="green">098</FONT>            {<a name="line.98"></a>
<FONT color="green">099</FONT>                    return create(aList, null);<a name="line.99"></a>
<FONT color="green">100</FONT>            }<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>            // Using TOP here because FSList is only available in the JCas.<a name="line.102"></a>
<FONT color="green">103</FONT>            public static Collection&lt;TOP&gt; create(FSList aList, Type type)<a name="line.103"></a>
<FONT color="green">104</FONT>            {<a name="line.104"></a>
<FONT color="green">105</FONT>                    TypeSystem ts = aList.getCAS().getTypeSystem();<a name="line.105"></a>
<FONT color="green">106</FONT>                    List&lt;FeatureStructure&gt; data = new ArrayList&lt;FeatureStructure&gt;();<a name="line.106"></a>
<FONT color="green">107</FONT>                    FSList i = aList;<a name="line.107"></a>
<FONT color="green">108</FONT>                    while (i instanceof NonEmptyFSList) {<a name="line.108"></a>
<FONT color="green">109</FONT>                            NonEmptyFSList l = (NonEmptyFSList) i;<a name="line.109"></a>
<FONT color="green">110</FONT>                            TOP value = l.getHead();<a name="line.110"></a>
<FONT color="green">111</FONT>                            if (value != null &amp;&amp; (type == null || ts.subsumes(type, value.getType()))) {<a name="line.111"></a>
<FONT color="green">112</FONT>                                    data.add(l.getHead());<a name="line.112"></a>
<FONT color="green">113</FONT>                            }<a name="line.113"></a>
<FONT color="green">114</FONT>                            i = l.getTail();<a name="line.114"></a>
<FONT color="green">115</FONT>                    }<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>                    return asList(data.toArray(new TOP[data.size()]));<a name="line.117"></a>
<FONT color="green">118</FONT>            }<a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>            private static class FSIteratorAdapter&lt;T extends FeatureStructure&gt; extends FSCollectionFactory&lt;T&gt;<a name="line.120"></a>
<FONT color="green">121</FONT>            {<a name="line.121"></a>
<FONT color="green">122</FONT>                    private volatile int sizeCache = -1;<a name="line.122"></a>
<FONT color="green">123</FONT>                    private final FSIterator&lt;T&gt; index;<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>                    public FSIteratorAdapter(FSIterator&lt;T&gt; aIterator)<a name="line.125"></a>
<FONT color="green">126</FONT>                    {<a name="line.126"></a>
<FONT color="green">127</FONT>                            index = aIterator.copy();<a name="line.127"></a>
<FONT color="green">128</FONT>                            index.moveToFirst();<a name="line.128"></a>
<FONT color="green">129</FONT>                    }<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>                    @Override<a name="line.131"></a>
<FONT color="green">132</FONT>                    public Iterator&lt;T&gt; iterator() {<a name="line.132"></a>
<FONT color="green">133</FONT>                            return index.copy();<a name="line.133"></a>
<FONT color="green">134</FONT>                    }<a name="line.134"></a>
<FONT color="green">135</FONT>    <a name="line.135"></a>
<FONT color="green">136</FONT>                    @Override<a name="line.136"></a>
<FONT color="green">137</FONT>                    public int size() {<a name="line.137"></a>
<FONT color="green">138</FONT>                            // Unfortunately FSIterator does not expose the sizes of its internal collection,<a name="line.138"></a>
<FONT color="green">139</FONT>                            // neither the current position although FSIteratorAggregate has a private field<a name="line.139"></a>
<FONT color="green">140</FONT>                            // with that information.<a name="line.140"></a>
<FONT color="green">141</FONT>                            if (sizeCache == -1) {<a name="line.141"></a>
<FONT color="green">142</FONT>                                    synchronized (this) {<a name="line.142"></a>
<FONT color="green">143</FONT>                                            if (sizeCache == -1) {<a name="line.143"></a>
<FONT color="green">144</FONT>                                                    FSIterator&lt;T&gt; clone = index.copy();<a name="line.144"></a>
<FONT color="green">145</FONT>                                                    clone.moveToFirst();<a name="line.145"></a>
<FONT color="green">146</FONT>                                                    sizeCache = 0;<a name="line.146"></a>
<FONT color="green">147</FONT>                                                    while (clone.isValid()) {<a name="line.147"></a>
<FONT color="green">148</FONT>                                                            sizeCache++;<a name="line.148"></a>
<FONT color="green">149</FONT>                                                            clone.moveToNext();<a name="line.149"></a>
<FONT color="green">150</FONT>                                                    }<a name="line.150"></a>
<FONT color="green">151</FONT>                                            }<a name="line.151"></a>
<FONT color="green">152</FONT>                                    }<a name="line.152"></a>
<FONT color="green">153</FONT>                            }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>                            return sizeCache;<a name="line.155"></a>
<FONT color="green">156</FONT>                    }<a name="line.156"></a>
<FONT color="green">157</FONT>            }<a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>            private static class AnnotationIndexAdapter&lt;T extends AnnotationFS&gt; extends FSCollectionFactory&lt;T&gt;<a name="line.159"></a>
<FONT color="green">160</FONT>            {<a name="line.160"></a>
<FONT color="green">161</FONT>                    private final AnnotationIndex&lt;T&gt; index;<a name="line.161"></a>
<FONT color="green">162</FONT>    <a name="line.162"></a>
<FONT color="green">163</FONT>                    public AnnotationIndexAdapter(AnnotationIndex&lt;T&gt; aIndex)<a name="line.163"></a>
<FONT color="green">164</FONT>                    {<a name="line.164"></a>
<FONT color="green">165</FONT>                            index = aIndex;<a name="line.165"></a>
<FONT color="green">166</FONT>                    }<a name="line.166"></a>
<FONT color="green">167</FONT>    <a name="line.167"></a>
<FONT color="green">168</FONT>                    @Override<a name="line.168"></a>
<FONT color="green">169</FONT>                    public Iterator&lt;T&gt; iterator() {<a name="line.169"></a>
<FONT color="green">170</FONT>                            return index.iterator();<a name="line.170"></a>
<FONT color="green">171</FONT>                    }<a name="line.171"></a>
<FONT color="green">172</FONT>    <a name="line.172"></a>
<FONT color="green">173</FONT>                    @Override<a name="line.173"></a>
<FONT color="green">174</FONT>                    public int size() {<a name="line.174"></a>
<FONT color="green">175</FONT>                            return index.size();<a name="line.175"></a>
<FONT color="green">176</FONT>                    }<a name="line.176"></a>
<FONT color="green">177</FONT>            }<a name="line.177"></a>
<FONT color="green">178</FONT>    }<a name="line.178"></a>




























































</PRE>
</BODY>
</HTML>
